/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.discovery.broker.messages;

import java.io.IOException;
import java.io.Serializable;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Properties;

import org.apache.log4j.Logger;

import cgl.narada.util.ObjectMarshaller;

/**
 * Skeletal structure of a Broker Advertisement <br>
 * Created on Mar 23, 2005
 * 
 * @author Harshawardhan Gadgil (hgadgil@grids.ucs.indiana.edu)
 */

public class BrokerAdvertisement implements Serializable {

   static Logger log = Logger.getLogger("BrokerAdvertisement");

   /** Host on which this broker is hosted */
   String hostname;

   /**
    * Supported transport protocols @ this broker (successfully registered
    * LinkFactories)
    */
   Hashtable supportedTransportProtocols;

   /**
    * Geographical and Institutional Information, configured from config
    * file(statically) E.g. CGL, Indiana University, Bloomington, IN, U.S.A.
    */
   String info;

   /** What network does this broker belong to */
   String belongsToNetwork;

   /**
    * Marshalls the object into an array of bytes.
    * 
    * @return an array of bytes representing the marshaller object, null if
    *         error occurs
    */
   public byte[] getBytes() {
      try {
         return ObjectMarshaller.marshall(this);
      } catch (IOException e) {
         log.error("", e);
         return null;
      }
   }

   /**
    * Unmarshalls the bytes as a BrokerAdvertisement object
    * 
    * @param objectBytes
    * @return BrokerAdvertisement if successful, null if error occurs
    */
   public static BrokerAdvertisement createObjectFromBytes(byte[] objectBytes) {
      try {
         return (BrokerAdvertisement) ObjectMarshaller.unmarshall(objectBytes);
      } catch (IOException e) {
         log.error("", e);
      } catch (ClassNotFoundException e) {
         log.error("", e);
      }
      return null;
   }

   /**
    * For debugging purposes
    */
   public String toString() {
      StringBuffer result = new StringBuffer();

      result.append("HOST: " + hostname + "\n");
      result.append("INFO: " + info + "\n");

      for (Enumeration e = supportedTransportProtocols.keys(); e
               .hasMoreElements();) {
         String protocol = (String) e.nextElement();
         result.append("\t-> " + protocol + "\n");
         Properties protoProps = (Properties) supportedTransportProtocols
                  .get(protocol);
         for (Enumeration eP = protoProps.keys(); eP.hasMoreElements();) {
            String prop = (String) eP.nextElement();
            String value = protoProps.getProperty(prop);
            result.append("\t\t" + prop + ": " + value + "\n");
         }
      }

      return result.toString();
   }

   /**
    * @return Returns the belongsToNetwork.
    */
   public final String getBelongsToNetwork() {
      return belongsToNetwork;
   }

   /**
    * @param belongsToNetwork
    *           The belongsToNetwork to set.
    */
   public final void setBelongsToNetwork(String belongsToNetwork) {
      this.belongsToNetwork = belongsToNetwork;
   }

   /**
    * @return Returns the hostname.
    */
   public final String getHostname() {
      return hostname;
   }

   /**
    * @param hostname
    *           The hostname to set.
    */
   public final void setHostname(String hostname) {
      this.hostname = hostname;
   }

   /**
    * @return Returns the info.
    */
   public final String getInfo() {
      return info;
   }

   /**
    * @param info
    *           The info to set.
    */
   public final void setInfo(String info) {
      this.info = info;
   }

   /**
    * @return Returns the supportedTransportProtocols.
    */
   public synchronized final Hashtable getSupportedTransportProtocols() {
      return supportedTransportProtocols;
   }

   /**
    * @param supportedTransportProtocols
    *           The supportedTransportProtocols to set.
    */
   public synchronized final void setSupportedTransportProtocols(
            Hashtable supportedTransportProtocols) {
      this.supportedTransportProtocols = supportedTransportProtocols;
   }
}